grideye2.h File Reference

This file contains API for Grid-EYE 2 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"

Go to the source code of this file.

Data Structures
struct	grideye2_t
	Grid-EYE 2 Click context object. More...
struct	grideye2_cfg_t
	Grid-EYE 2 Click configuration object. More...

Macros
#define	GRIDEYE2_REG_PCLT   0x00
	Grid-EYE 2 register list.
#define	GRIDEYE2_REG_RST   0x01
#define	GRIDEYE2_REG_FPSC   0x02
#define	GRIDEYE2_REG_INTC   0x03
#define	GRIDEYE2_REG_STAT   0x04
#define	GRIDEYE2_REG_SCLR   0x05
#define	GRIDEYE2_REG_AVE   0x07
#define	GRIDEYE2_REG_INTHL   0x08
#define	GRIDEYE2_REG_INTHH   0x09
#define	GRIDEYE2_REG_INTLL   0x0A
#define	GRIDEYE2_REG_INTLH   0x0B
#define	GRIDEYE2_REG_IHYSL   0x0C
#define	GRIDEYE2_REG_IHYSH   0x0D
#define	GRIDEYE2_REG_TTHL   0x0E
#define	GRIDEYE2_REG_TTHH   0x0F
#define	GRIDEYE2_REG_INT0   0x10
#define	GRIDEYE2_REG_INT1   0x11
#define	GRIDEYE2_REG_INT2   0x12
#define	GRIDEYE2_REG_INT3   0x13
#define	GRIDEYE2_REG_INT4   0x14
#define	GRIDEYE2_REG_INT5   0x15
#define	GRIDEYE2_REG_INT6   0x16
#define	GRIDEYE2_REG_INT7   0x17
#define	GRIDEYE2_REG_AVE_SET   0x1F
#define	GRIDEYE2_REG_TO1L   0x80
#define	GRIDEYE2_REG_TO1H   0x81
#define	GRIDEYE2_PCLT_NORMAL_MODE   0x00
	Grid-EYE 2 PCLT register setting.
#define	GRIDEYE2_PCLT_SLEEP_MODE   0x10
#define	GRIDEYE2_RST_FLAG   0x30
	Grid-EYE 2 RST register setting.
#define	GRIDEYE2_RST_INITIAL   0x3F
#define	GRIDEYE2_FPSC_10FPS   0x00
	Grid-EYE 2 FPSC register setting.
#define	GRIDEYE2_FPSC_1FPS   0x01
#define	GRIDEYE2_INTC_INTMOD_DIFF   0x00
	Grid-EYE 2 INTC register setting.
#define	GRIDEYE2_INTC_INTMOD_ABS   0x02
#define	GRIDEYE2_INTC_INTMOD_MASK   0x02
#define	GRIDEYE2_INTC_INTEN_INACTIVE   0x00
#define	GRIDEYE2_INTC_INTEN_ACTIVE   0x01
#define	GRIDEYE2_INTC_INTEN_MASK   0x01
#define	GRIDEYE2_STAT_OVF_IRS   0x04
	Grid-EYE 2 STAT register setting.
#define	GRIDEYE2_STAT_INTF   0x02
#define	GRIDEYE2_AVE_MAMOD_OFF   0x00
	Grid-EYE 2 AVE register setting.
#define	GRIDEYE2_AVE_MAMOD_ON   0x20
#define	GRIDEYE2_AVE_SET_0   0x50
#define	GRIDEYE2_AVE_SET_1   0x45
#define	GRIDEYE2_AVE_SET_2   0x57
#define	GRIDEYE2_AVE_SET_3   0x00
#define	GRIDEYE2_DATA_SIGN_BIT   0x0800
	Grid-EYE 2 data calculation setting.
#define	GRIDEYE2_DATA_FILL_SIGN   0xF000
#define	GRIDEYE2_DATA_LSB   0.25f
#define	GRIDEYE2_NUM_PIXELS   64
#define	GRIDEYE2_DEVICE_ADDRESS_0   0x68
	Grid-EYE 2 device address setting.
#define	GRIDEYE2_DEVICE_ADDRESS_1   0x69
#define	GRIDEYE2_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	grideye2_return_value_t { GRIDEYE2_OK = 0 , GRIDEYE2_ERROR = -1 }
	Grid-EYE 2 Click return value data. More...

Functions
void	grideye2_cfg_setup (grideye2_cfg_t *cfg)
	Grid-EYE 2 configuration object setup function.
err_t	grideye2_init (grideye2_t *ctx, grideye2_cfg_t *cfg)
	Grid-EYE 2 initialization function.
err_t	grideye2_default_cfg (grideye2_t *ctx)
	Grid-EYE 2 default configuration function.
err_t	grideye2_write_reg_bytes (grideye2_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
	Grid-EYE 2 write reg bytes function.
err_t	grideye2_write_reg_byte (grideye2_t *ctx, uint8_t reg, uint8_t data_in)
	Grid-EYE 2 write reg byte function.
err_t	grideye2_write_reg_word (grideye2_t *ctx, uint8_t reg, uint16_t data_in)
	Grid-EYE 2 write reg word function.
err_t	grideye2_read_reg_bytes (grideye2_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
	Grid-EYE 2 read reg bytes function.
err_t	grideye2_read_reg_byte (grideye2_t *ctx, uint8_t reg, uint8_t *data_out)
	Grid-EYE 2 read reg byte function.
err_t	grideye2_read_reg_word (grideye2_t *ctx, uint8_t reg, uint16_t *data_out)
	Grid-EYE 2 read reg word function.
uint8_t	grideye2_get_int_pin (grideye2_t *ctx)
	Grid-EYE 2 get INT pin function.
err_t	grideye2_read_grid (grideye2_t *ctx)
	Grid-EYE 2 read grid function.
err_t	grideye2_clear_status (grideye2_t *ctx)
	Grid-EYE 2 clear status function.

Detailed Description

This file contains API for Grid-EYE 2 Click Driver.

Enumeration Type Documentation

grideye2_return_value_t

enum grideye2_return_value_t

Grid-EYE 2 Click return value data.

Predefined enum values for driver return values.

Enumerator
GRIDEYE2_OK
GRIDEYE2_ERROR